<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Reranker Framework (ReFr): training-time.H Source File</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />

<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>

</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">Reranker Framework (ReFr)
   
   </div>
   <div id="projectbrief">Reranking framework for structure prediction and discriminative language modeling</div>
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.6.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>File&#160;Members</span></a></li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="headertitle">
<div class="title">training-time.H</div>  </div>
</div><!--header-->
<div class="contents">
<a href="training-time_8_h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// Copyright 2012, Google Inc.</span>
<a name="l00002"></a>00002 <span class="comment">// All rights reserved.</span>
<a name="l00003"></a>00003 <span class="comment">// </span>
<a name="l00004"></a>00004 <span class="comment">// Redistribution and use in source and binary forms, with or without</span>
<a name="l00005"></a>00005 <span class="comment">// modification, are permitted provided that the following conditions are</span>
<a name="l00006"></a>00006 <span class="comment">// met:</span>
<a name="l00007"></a>00007 <span class="comment">// </span>
<a name="l00008"></a>00008 <span class="comment">//   * Redistributions of source code must retain the above copyright</span>
<a name="l00009"></a>00009 <span class="comment">//     notice, this list of conditions and the following disclaimer.</span>
<a name="l00010"></a>00010 <span class="comment">//   * Redistributions in binary form must reproduce the above</span>
<a name="l00011"></a>00011 <span class="comment">//     copyright notice, this list of conditions and the following disclaimer</span>
<a name="l00012"></a>00012 <span class="comment">//     in the documentation and/or other materials provided with the</span>
<a name="l00013"></a>00013 <span class="comment">//     distribution.</span>
<a name="l00014"></a>00014 <span class="comment">//   * Neither the name of Google Inc. nor the names of its</span>
<a name="l00015"></a>00015 <span class="comment">//     contributors may be used to endorse or promote products derived from</span>
<a name="l00016"></a>00016 <span class="comment">//     this software without specific prior written permission.</span>
<a name="l00017"></a>00017 <span class="comment">//</span>
<a name="l00018"></a>00018 <span class="comment">// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS</span>
<a name="l00019"></a>00019 <span class="comment">// &quot;AS IS&quot; AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT</span>
<a name="l00020"></a>00020 <span class="comment">// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR</span>
<a name="l00021"></a>00021 <span class="comment">// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT</span>
<a name="l00022"></a>00022 <span class="comment">// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,</span>
<a name="l00023"></a>00023 <span class="comment">// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT</span>
<a name="l00024"></a>00024 <span class="comment">// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,           </span>
<a name="l00025"></a>00025 <span class="comment">// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY           </span>
<a name="l00026"></a>00026 <span class="comment">// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT</span>
<a name="l00027"></a>00027 <span class="comment">// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE</span>
<a name="l00028"></a>00028 <span class="comment">// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span>
<a name="l00029"></a>00029 <span class="comment">// -----------------------------------------------------------------------------</span>
<a name="l00030"></a>00030 <span class="comment">//</span>
<a name="l00031"></a>00031 <span class="comment">//</span>
<a name="l00037"></a>00037 <span class="comment"></span>
<a name="l00038"></a>00038 <span class="preprocessor">#ifndef RERANKER_TRAINING_TIME_H_</span>
<a name="l00039"></a>00039 <span class="preprocessor"></span><span class="preprocessor">#define RERANKER_TRAINING_TIME_H_</span>
<a name="l00040"></a>00040 <span class="preprocessor"></span>
<a name="l00041"></a>00041 <span class="preprocessor">#include &lt;ctime&gt;</span>
<a name="l00042"></a>00042 <span class="preprocessor">#include &lt;iostream&gt;</span>
<a name="l00043"></a>00043 <span class="preprocessor">#include &lt;string&gt;</span>
<a name="l00044"></a>00044 <span class="preprocessor">#include &lt;sstream&gt;</span>
<a name="l00045"></a>00045 
<a name="l00046"></a>00046 <span class="keyword">namespace </span>reranker {
<a name="l00047"></a>00047 
<a name="l00048"></a>00048 <span class="keyword">using</span> std::string;
<a name="l00049"></a>00049 <span class="keyword">using</span> std::ostream;
<a name="l00050"></a>00050 
<a name="l00056"></a><a class="code" href="classreranker_1_1_time.html">00056</a> <span class="keyword">class </span><a class="code" href="classreranker_1_1_time.html" title="A simple class to hold the three notions of time during training: the current epoch, the current time index within the current epoch, and the absolute time index.">Time</a> {
<a name="l00057"></a>00057  <span class="keyword">public</span>:
<a name="l00059"></a><a class="code" href="classreranker_1_1_time.html#a1b73861f59b95ac90e3cc28db9b2bf58">00059</a>   <a class="code" href="classreranker_1_1_time.html#a1b73861f59b95ac90e3cc28db9b2bf58" title="Constructs a new time instance, ready for its indices to be incremented.">Time</a>() : epoch_(-1), index_(-1), absolute_index_(-1),
<a name="l00060"></a>00060            absolute_time_(clock()), time_since_last_epoch_(absolute_time_) { }
<a name="l00066"></a><a class="code" href="classreranker_1_1_time.html#aafdca8f1ef34bd508246704dc2eaced8">00066</a>   <a class="code" href="classreranker_1_1_time.html#a1b73861f59b95ac90e3cc28db9b2bf58" title="Constructs a new time instance, ready for its indices to be incremented.">Time</a>(<span class="keywordtype">int</span> <a class="code" href="classreranker_1_1_time.html#a18d952cada06cc20fb8382b098e1ee98" title="Returns the index of the current epoch.">epoch</a>, <span class="keywordtype">int</span> <a class="code" href="classreranker_1_1_time.html#a82f423a8daf71228e33b91186964f5c3" title="Returns the index of the current training example within the current epoch.">index</a>, <span class="keywordtype">int</span> <a class="code" href="classreranker_1_1_time.html#a27932d36ed9adabd73eab8a9b94cfdc9" title="Returns the total number of training examples seen in all epochs.">absolute_index</a>) :
<a name="l00067"></a>00067       epoch_(epoch),
<a name="l00068"></a>00068       index_(index),
<a name="l00069"></a>00069       absolute_index_(absolute_index),
<a name="l00070"></a>00070       absolute_time_(clock()), time_since_last_epoch_(absolute_time_) { }
<a name="l00071"></a>00071 
<a name="l00072"></a>00072   <span class="comment">// accessors</span>
<a name="l00074"></a><a class="code" href="classreranker_1_1_time.html#a18d952cada06cc20fb8382b098e1ee98">00074</a> <span class="comment"></span>  <span class="keywordtype">int</span> <a class="code" href="classreranker_1_1_time.html#a18d952cada06cc20fb8382b098e1ee98" title="Returns the index of the current epoch.">epoch</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> epoch_; }
<a name="l00077"></a><a class="code" href="classreranker_1_1_time.html#a82f423a8daf71228e33b91186964f5c3">00077</a>   <span class="keywordtype">int</span> <a class="code" href="classreranker_1_1_time.html#a82f423a8daf71228e33b91186964f5c3" title="Returns the index of the current training example within the current epoch.">index</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> index_; }
<a name="l00079"></a><a class="code" href="classreranker_1_1_time.html#a27932d36ed9adabd73eab8a9b94cfdc9">00079</a>   <span class="keywordtype">int</span> <a class="code" href="classreranker_1_1_time.html#a27932d36ed9adabd73eab8a9b94cfdc9" title="Returns the total number of training examples seen in all epochs.">absolute_index</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> absolute_index_; }
<a name="l00080"></a>00080 
<a name="l00081"></a><a class="code" href="classreranker_1_1_time.html#a07f9ec2004438a55f7813e70c50423c6">00081</a>   <span class="keywordtype">double</span> <a class="code" href="classreranker_1_1_time.html#a07f9ec2004438a55f7813e70c50423c6">absolute_seconds</a>()<span class="keyword"> const </span>{
<a name="l00082"></a>00082     clock_t diff_time = clock() - absolute_time_;
<a name="l00083"></a>00083     <span class="keywordflow">return</span> ((<span class="keywordtype">double</span>)diff_time) / CLOCKS_PER_SEC;
<a name="l00084"></a>00084   }
<a name="l00085"></a><a class="code" href="classreranker_1_1_time.html#aec0429b62beee4807a4e62c2665f5a00">00085</a>   <span class="keywordtype">double</span> <a class="code" href="classreranker_1_1_time.html#aec0429b62beee4807a4e62c2665f5a00">seconds_since_last_epoch</a>()<span class="keyword"> const </span>{
<a name="l00086"></a>00086     clock_t diff_time = clock() - time_since_last_epoch_;
<a name="l00087"></a>00087     <span class="keywordflow">return</span> ((<span class="keywordtype">double</span>)diff_time) / CLOCKS_PER_SEC;
<a name="l00088"></a>00088   }
<a name="l00089"></a>00089 
<a name="l00090"></a><a class="code" href="classreranker_1_1_time.html#af84f68b9ee867f2b429bd46c8a2f3397">00090</a>   <span class="keyword">friend</span> ostream &amp;<a class="code" href="classreranker_1_1_time.html#af84f68b9ee867f2b429bd46c8a2f3397">operator&lt;&lt;</a>(ostream &amp;os, <span class="keyword">const</span> <a class="code" href="classreranker_1_1_time.html" title="A simple class to hold the three notions of time during training: the current epoch, the current time index within the current epoch, and the absolute time index.">Time</a> &amp;time) {
<a name="l00091"></a>00091     <span class="keywordflow">return</span> os &lt;&lt; time.<a class="code" href="classreranker_1_1_time.html#a18d952cada06cc20fb8382b098e1ee98" title="Returns the index of the current epoch.">epoch</a>() &lt;&lt; <span class="stringliteral">&quot;,&quot;</span> &lt;&lt; time.<a class="code" href="classreranker_1_1_time.html#a82f423a8daf71228e33b91186964f5c3" title="Returns the index of the current training example within the current epoch.">index</a>() &lt;&lt; <span class="stringliteral">&quot;;&quot;</span>
<a name="l00092"></a>00092               &lt;&lt; time.<a class="code" href="classreranker_1_1_time.html#a27932d36ed9adabd73eab8a9b94cfdc9" title="Returns the total number of training examples seen in all epochs.">absolute_index</a>();
<a name="l00093"></a>00093   }
<a name="l00094"></a>00094 
<a name="l00095"></a><a class="code" href="classreranker_1_1_time.html#a1e8b9be0b48cd8cbb360f23a638e12c6">00095</a>   <span class="keywordtype">string</span> <a class="code" href="classreranker_1_1_time.html#a1e8b9be0b48cd8cbb360f23a638e12c6">to_string</a>()<span class="keyword"> const </span>{
<a name="l00096"></a>00096     std::ostringstream oss;
<a name="l00097"></a>00097     oss &lt;&lt; *<span class="keyword">this</span>;
<a name="l00098"></a>00098     <span class="keywordflow">return</span> oss.str();
<a name="l00099"></a>00099   }
<a name="l00100"></a>00100 
<a name="l00101"></a>00101   <span class="comment">// mutators</span>
<a name="l00104"></a><a class="code" href="classreranker_1_1_time.html#aacb31465040806ff8705e168056b01aa">00104</a> <span class="comment"></span>  <span class="keywordtype">void</span> <a class="code" href="classreranker_1_1_time.html#aacb31465040806ff8705e168056b01aa" title="Increments both the time index for the current epoch and the absolute time index.">Tick</a>() {
<a name="l00105"></a>00105     index_++;
<a name="l00106"></a>00106     absolute_index_++;
<a name="l00107"></a>00107   }
<a name="l00109"></a><a class="code" href="classreranker_1_1_time.html#accd3f2b8a3d1ae3c7e1b1a5bee61d88d">00109</a>   <span class="keywordtype">void</span> <a class="code" href="classreranker_1_1_time.html#accd3f2b8a3d1ae3c7e1b1a5bee61d88d" title="Increments the epoch counter.">NewEpoch</a>() {
<a name="l00110"></a>00110     epoch_++;
<a name="l00111"></a>00111     index_ = -1;
<a name="l00112"></a>00112     time_since_last_epoch_ = clock();
<a name="l00113"></a>00113   }
<a name="l00114"></a>00114  <span class="keyword">private</span>:
<a name="l00115"></a>00115   <span class="keywordtype">int</span> epoch_;
<a name="l00116"></a>00116   <span class="keywordtype">int</span> index_;
<a name="l00117"></a>00117   <span class="keywordtype">int</span> absolute_index_;
<a name="l00118"></a>00118   clock_t absolute_time_;
<a name="l00119"></a>00119   clock_t time_since_last_epoch_;
<a name="l00120"></a>00120 };
<a name="l00121"></a>00121 
<a name="l00122"></a>00122 }  <span class="comment">// namespace reranker</span>
<a name="l00123"></a>00123 
<a name="l00124"></a>00124 <span class="preprocessor">#endif</span>
</pre></div></div><!-- contents -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Defines</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>



<hr class="footer"/><address class="footer"><small>
Generated on Tue Apr 9 2013 11:56:29 for Reranker Framework (ReFr) by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.6.1
</small></address>

</body>
</html>
